<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: UART Callback Events</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__scb__uart__macros__callback__events.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle">
<div class="title">UART Callback Events<div class="ingroups"><a class="el" href="group__group__scb.html">SCB          (Serial Communication Block)</a> &raquo; <a class="el" href="group__group__scb__uart.html">UART (SCB)</a> &raquo; <a class="el" href="group__group__scb__uart__macros.html">Macros</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>Macros to check UART events passed by <a class="el" href="group__group__scb__uart__data__structures.html#ga67e5d87e39311f4d001723f8718210c6">cy_cb_scb_uart_handle_events_t</a> callback. </p>
<p>Note that only single event is notified by the callback when it is called. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga5c4d6256e032c1095f632dcf237e842b"><td class="memItemLeft" align="right" valign="top"><a id="ga5c4d6256e032c1095f632dcf237e842b"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__macros__callback__events.html#ga5c4d6256e032c1095f632dcf237e842b">CY_SCB_UART_TRANSMIT_IN_FIFO_EVENT</a>&#160;&#160;&#160;(0x01UL)</td></tr>
<tr class="memdesc:ga5c4d6256e032c1095f632dcf237e842b"><td class="mdescLeft">&#160;</td><td class="mdescRight">All data elements specified by <a class="el" href="group__group__scb__uart__high__level__functions.html#ga12cc7712f9cb5e26b28d1d9a3a9576b4">Cy_SCB_UART_Transmit</a> have been loaded into the TX FIFO. <br /></td></tr>
<tr class="separator:ga5c4d6256e032c1095f632dcf237e842b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf7e87969a0f31bbcd1bcc84d8266c7b9"><td class="memItemLeft" align="right" valign="top"><a id="gaf7e87969a0f31bbcd1bcc84d8266c7b9"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__macros__callback__events.html#gaf7e87969a0f31bbcd1bcc84d8266c7b9">CY_SCB_UART_TRANSMIT_DONE_EVENT</a>&#160;&#160;&#160;(0x02UL)</td></tr>
<tr class="memdesc:gaf7e87969a0f31bbcd1bcc84d8266c7b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The transmit operation started by <a class="el" href="group__group__scb__uart__high__level__functions.html#ga12cc7712f9cb5e26b28d1d9a3a9576b4">Cy_SCB_UART_Transmit</a> is complete. <br /></td></tr>
<tr class="separator:gaf7e87969a0f31bbcd1bcc84d8266c7b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga027091599ffb1698dc4c9e2877e17103"><td class="memItemLeft" align="right" valign="top"><a id="ga027091599ffb1698dc4c9e2877e17103"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__macros__callback__events.html#ga027091599ffb1698dc4c9e2877e17103">CY_SCB_UART_RECEIVE_DONE_EVENT</a>&#160;&#160;&#160;(0x04UL)</td></tr>
<tr class="memdesc:ga027091599ffb1698dc4c9e2877e17103"><td class="mdescLeft">&#160;</td><td class="mdescRight">The receive operation started by <a class="el" href="group__group__scb__uart__high__level__functions.html#gace7421c664f582ab4ad4bade0683f209">Cy_SCB_UART_Receive</a> is complete. <br /></td></tr>
<tr class="separator:ga027091599ffb1698dc4c9e2877e17103"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabff487560d6e742eebcade29c4bea894"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__macros__callback__events.html#gabff487560d6e742eebcade29c4bea894">CY_SCB_UART_RB_FULL_EVENT</a>&#160;&#160;&#160;(0x08UL)</td></tr>
<tr class="memdesc:gabff487560d6e742eebcade29c4bea894"><td class="mdescLeft">&#160;</td><td class="mdescRight">The ring buffer is full, there is no more space for additional data.  <a href="#gabff487560d6e742eebcade29c4bea894">More...</a><br /></td></tr>
<tr class="separator:gabff487560d6e742eebcade29c4bea894"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga83c49fb93bfa02d045b1c7bff4b61db7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__macros__callback__events.html#ga83c49fb93bfa02d045b1c7bff4b61db7">CY_SCB_UART_RECEIVE_ERR_EVENT</a>&#160;&#160;&#160;(0x10UL)</td></tr>
<tr class="memdesc:ga83c49fb93bfa02d045b1c7bff4b61db7"><td class="mdescLeft">&#160;</td><td class="mdescRight">An error was detected during the receive operation.  <a href="#ga83c49fb93bfa02d045b1c7bff4b61db7">More...</a><br /></td></tr>
<tr class="separator:ga83c49fb93bfa02d045b1c7bff4b61db7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf98f8029f3625cf625c617981de41511"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__macros__callback__events.html#gaf98f8029f3625cf625c617981de41511">CY_SCB_UART_TRANSMIT_ERR_EVENT</a>&#160;&#160;&#160;(0x20UL)</td></tr>
<tr class="memdesc:gaf98f8029f3625cf625c617981de41511"><td class="mdescLeft">&#160;</td><td class="mdescRight">An error was detected during the transmit operation.  <a href="#gaf98f8029f3625cf625c617981de41511">More...</a><br /></td></tr>
<tr class="separator:gaf98f8029f3625cf625c617981de41511"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga36424b979b2625f0233b4adca55a2319"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__macros__callback__events.html#ga36424b979b2625f0233b4adca55a2319">CY_SCB_UART_RECEIVE_NOT_EMTPY</a>&#160;&#160;&#160;(0x40UL)</td></tr>
<tr class="memdesc:ga36424b979b2625f0233b4adca55a2319"><td class="mdescLeft">&#160;</td><td class="mdescRight">The receive fifo is not empty.  <a href="#ga36424b979b2625f0233b4adca55a2319">More...</a><br /></td></tr>
<tr class="separator:ga36424b979b2625f0233b4adca55a2319"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga17879f396999a6f348af06901faa7d91"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__scb__uart__macros__callback__events.html#ga17879f396999a6f348af06901faa7d91">CY_SCB_UART_TRANSMIT_EMTPY</a>&#160;&#160;&#160;(0x80UL)</td></tr>
<tr class="memdesc:ga17879f396999a6f348af06901faa7d91"><td class="mdescLeft">&#160;</td><td class="mdescRight">The transmit fifo is empty.  <a href="#ga17879f396999a6f348af06901faa7d91">More...</a><br /></td></tr>
<tr class="separator:ga17879f396999a6f348af06901faa7d91"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="gabff487560d6e742eebcade29c4bea894"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabff487560d6e742eebcade29c4bea894">&#9670;&nbsp;</a></span>CY_SCB_UART_RB_FULL_EVENT</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_SCB_UART_RB_FULL_EVENT&#160;&#160;&#160;(0x08UL)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The ring buffer is full, there is no more space for additional data. </p>
<p>Additional data is stored in the RX FIFO until it becomes full, at which point data is dropped. </p>

</div>
</div>
<a id="ga83c49fb93bfa02d045b1c7bff4b61db7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga83c49fb93bfa02d045b1c7bff4b61db7">&#9670;&nbsp;</a></span>CY_SCB_UART_RECEIVE_ERR_EVENT</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_SCB_UART_RECEIVE_ERR_EVENT&#160;&#160;&#160;(0x10UL)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>An error was detected during the receive operation. </p>
<p>This includes overflow, frame error, or parity error. Check <a class="el" href="group__group__scb__uart__high__level__functions.html#ga4cc7bd2f28ef5e170e663414dba66f8c">Cy_SCB_UART_GetReceiveStatus</a> to determine the source of the error. </p>

</div>
</div>
<a id="gaf98f8029f3625cf625c617981de41511"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf98f8029f3625cf625c617981de41511">&#9670;&nbsp;</a></span>CY_SCB_UART_TRANSMIT_ERR_EVENT</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_SCB_UART_TRANSMIT_ERR_EVENT&#160;&#160;&#160;(0x20UL)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>An error was detected during the transmit operation. </p>
<p>This includes a NACK or lost arbitration. Check <a class="el" href="group__group__scb__uart__high__level__functions.html#ga92ea29d41db81f995b0ff442d6639191">Cy_SCB_UART_GetTransmitStatus</a> to determine the source of the error </p>

</div>
</div>
<a id="ga36424b979b2625f0233b4adca55a2319"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga36424b979b2625f0233b4adca55a2319">&#9670;&nbsp;</a></span>CY_SCB_UART_RECEIVE_NOT_EMTPY</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_SCB_UART_RECEIVE_NOT_EMTPY&#160;&#160;&#160;(0x40UL)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The receive fifo is not empty. </p>
<p>To use this event the <a class="el" href="group__group__scb__common__macros__rx__intr.html#gaeda2c4c71a6d2845159e636640974f37">CY_SCB_RX_INTR_NOT_EMPTY</a> interrupt must be enabled by the user. </p>

</div>
</div>
<a id="ga17879f396999a6f348af06901faa7d91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga17879f396999a6f348af06901faa7d91">&#9670;&nbsp;</a></span>CY_SCB_UART_TRANSMIT_EMTPY</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_SCB_UART_TRANSMIT_EMTPY&#160;&#160;&#160;(0x80UL)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The transmit fifo is empty. </p>
<p>To use this event the <a class="el" href="group__group__scb__uart__macros__tx__fifo__status.html#gafb9a349f995e46583edd9cdc16efc0af">CY_SCB_UART_TX_EMPTY</a> interrupt must be enabled by the user. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
